/// Copyright 2007-8 Faraday Media
/// 
/// Licensed under the Apache License, Version 2.0 (the "License"); 
/// you may not use this file except in compliance with the License. 
/// You may obtain a copy of the License at 
/// 
///   http://www.apache.org/licenses/LICENSE-2.0 
/// 
/// Unless required by applicable law or agreed to in writing, software 
/// distributed under the License is distributed on an "AS IS" BASIS, 
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
/// See the License for the specific language governing permissions and 
/// limitations under the License.
using System;

namespace MetaSharp.XML {
  ///<summary>
  /// Attribute to be used when mapping a property to a dictionary-style store that indicates which
  /// property in the element is to be used as the key.
  ///</summary>
  public class AutoWrapperKeyAttribute : Attribute {
    private readonly string mKeyAttribute;

    ///<summary>
    /// Creates a new key attribute.
    ///</summary>
    ///<param name="pKeyAttribute">the name of the property in the element that is to be used as the key</param>
    public AutoWrapperKeyAttribute(string pKeyAttribute) {
      mKeyAttribute = pKeyAttribute;
    }

    ///<summary>
    /// The name of the property in the element to be used as the key
    ///</summary>
    public string KeyAttribute {
      get { return mKeyAttribute; }
    }
  }
}
